Classdoc -- Automatic Documentation of C++ Classes

Abstract.

Classdoc is an AWK program that transforms C++ source code into UNIX
`man'-style documents.  The purpose is to improve the readability of
C++ class documentation without the need for additional document
files.  Classdoc achieves this by formatting and simple reordering of
the source code.  The as yet non-existent paper describes the
capabilities and limitations of classdoc, underlying assumptions of
C++ programming style, and the usefulness of simple-minded parsing
relying on programmer cooperation.sy

Although Classdoc may be confused by some programming styles, and will
not understand many perfectly legal C++ header files, it should not
discard any useful information.

The distribution contains the following:

	1.  An AWK program (requires `nawk', GNU `gawk' or compatible).

	2.  A sample shell script + manual page.

	3.  This message.

	4.  Two test files (list.H and diagram.H) to demonstrate
	    a programming style `classdoc' understands.

Comments are gratefully accepted.  Please send your views to:

Dag Michael Bruck
Department of Automatic Control		Internet:  dag@control.lth.se
Lund Institute of Technology
P. O. Box 118				Phone:	+46 46-108779
S-221 00 Lund, SWEDEN			Fax:    +46 46-138118